Type annotation infrastructure and initial typing for qtbot.py #605

herobank110 · 2025-05-22T22:35:20Z

Initial version of adding type annotations to the library.

infrastructure of mypy in precommit (ci and local type checking)
Typing focused around qtbot.py to start with
Note: qt objects are typed with aliases refering to Any - this may be upgraded in future to use correct types.

Fixes #417

src/pytestqt/qtbot.py

for more information, see https://pre-commit.ci

src/pytestqt/qtbot.py

nicoddemus

Thanks a lot @herobank110!

Left some comments, please take a look!

docs/conf.py

src/pytestqt/__init__.py

src/pytestqt/qtbot.py

.pre-commit-config.yaml

Co-authored-by: Bruno Oliveira <[email protected]>

nicoddemus

Thanks a lot @herobank110, this looks great!

nicoddemus · 2025-06-13T17:24:40Z

Thanks @herobank110!

Leaving it open for a few days to give @The-Compiler a chance to review too. 👍

herobank110 · 2025-06-15T12:56:23Z

Thanks @herobank110!

Leaving it open for a few days to give @The-Compiler a chance to review too. 👍

Keen to continue contributing with the typing and other stuff you may have

The-Compiler

Thank you, I'm pretty excited for this! ✨

I added a couple of comments for things I noticed, mostly they're minor things and shouldn't block anything though. A todo-list for follow-ups if we don't do them as part of this PR:

Use Type Hinting Generics in Standard Collections (list, dict, type over typing.List etc.)
Use from __future__ import annotations
- Use PEP 604: New Type Union Operator, i.e. TheType | None instead of Optional[TheType]
- Use "bare" annotations for forward declarations instead of stringified ones
- Configure ruff to enforce from __future__ import annotations on every file for consistency
Remove redundant type annotations from Sphinx docstrings (and possibly configure Sphinx to pick up the annotations, not sure what's needed for that nowadays)

The-Compiler · 2025-06-18T06:34:47Z

mypy.ini

@@ -0,0 +1,9 @@
+[mypy]
+exclude = ^docs/
+no_implicit_optional = True


This is already the default since mypy 0.980 (~September 2022).

The-Compiler · 2025-06-18T06:39:38Z

src/pytestqt/exceptions.py

+CapturedException = Tuple[Type[BaseException], BaseException, TracebackType]
+CapturedExceptions = List[CapturedException]


Suggested change

CapturedException = Tuple[Type[BaseException], BaseException, TracebackType]

CapturedExceptions = List[CapturedException]

CapturedException = tuple[type[BaseException], BaseException, TracebackType]

CapturedExceptions = list[CapturedException]

(possible since Python 3.9 which is now the earliest version we support, and avoids having to import all that stuff from typing).

The-Compiler · 2025-06-18T06:43:52Z

src/pytestqt/qtbot.py

@@ -358,13 +403,13 @@ def waitSignal(self, signal, *, timeout=5000, raising=None, check_params_cb=None

    def waitSignals(
        self,
-        signals,
+        signals: List[SignalInstance],


Suggested change

signals: List[SignalInstance],

signals: list[SignalInstance],

The-Compiler · 2025-06-18T06:44:05Z

src/pytestqt/qtbot.py

-    ):
+        timeout: int = 5000,
+        raising: Optional[bool] = None,
+        check_params_cbs: Optional[List[CheckParamsCb]] = None,


Suggested change

check_params_cbs: Optional[List[CheckParamsCb]] = None,

check_params_cbs: Optional[list[CheckParamsCb]] = None,

The-Compiler · 2025-06-18T06:49:02Z

src/pytestqt/qtbot.py

+    # provide easy access to exceptions to qtbot fixtures
+    SignalEmittedError = SignalEmittedError
+    TimeoutError = TimeoutError
+    ScreenshotError = ScreenshotError
+    CallbackCalledTwiceError = CallbackCalledTwiceError


Those seem somewhat confusing - I wonder if we should from ... import SignalEmittedError as SignalEmittedError_ or something to make clear what happens here?

The-Compiler · 2025-06-18T06:51:34Z

src/pytestqt/qtbot.py

-
-def _add_widget(item, widget, *, before_close_func=None):
+def _add_widget(
+    item: Any,


Maybe

Suggested change

item: Any,

item: pytest.Item,

and add a type ignore about us monkeypatching stuff on it? Long-term, we should be using Stash instead anyways.

Same also for the other utility methods taking item below.

The-Compiler · 2025-06-18T06:52:34Z

src/pytestqt/qtbot.py

@@ -769,7 +824,9 @@ class _WaitWidgetContextManager:
    Context manager implementation used by ``waitActive`` and ``waitExposed`` methods.
    """

-    def __init__(self, method_name, adjective_name, widget, timeout):
+    def __init__(
+        self, method_name: str, adjective_name: str, widget: QWidget, timeout: int


Suggested change

self, method_name: str, adjective_name: str, widget: QWidget, timeout: int

self, method_name: str, adjective_name: Literal["activated", "exposed"], widget: QWidget, timeout: int

maybe, based on the docstring?

The-Compiler · 2025-06-18T06:52:48Z

src/pytestqt/qtbot.py

-    def __exit__(self, exc_type, exc_val, exc_tb):
+    def __exit__(
+        self,
+        exc_type: Optional[Type[BaseException]],


Suggested change

exc_type: Optional[Type[BaseException]],

exc_type: Optional[type[BaseException]],

The-Compiler · 2025-06-18T06:59:28Z

src/pytestqt/wait_signal.py

@@ -1,10 +1,12 @@
 import functools
 import dataclasses
-from typing import Any
+from typing import Any, Callable


typing.Callable is deprecated, this should be using collections.abc.Callable instead.

The-Compiler · 2025-06-18T06:59:33Z

src/pytestqt/qtbot.py

 import weakref
 import warnings
+from typing import (
+    TYPE_CHECKING,
+    Callable,


typing.Callable is deprecated, this should be using collections.abc.Callable instead.

herobank110 added 4 commits May 22, 2025 23:22

try import from qtpy

0c57f88

mypy precommit

373ea8d

ignore attrdefined

c0bb438

only check src

30f9b69

herobank110 marked this pull request as draft May 22, 2025 22:39

ignore more types

0720c53

herobank110 mentioned this pull request May 22, 2025

Type annotations #417

Open

nicoddemus reviewed May 26, 2025

View reviewed changes

src/pytestqt/qtbot.py Outdated Show resolved Hide resolved

herobank110 and others added 5 commits May 31, 2025 18:49

add pytyped files-partial

9128ce3

change qtpy to Any alias

9a8a4b5

save

d9c8a5c

add more typing

acc1994

[pre-commit.ci] auto fixes from pre-commit.com hooks

97c08fe

for more information, see https://pre-commit.ci

herobank110 changed the title ~~Type annotation test~~ Type annotation infrastructure and initial typing for qtbot.py Jun 8, 2025

herobank110 commented Jun 8, 2025

View reviewed changes

src/pytestqt/qtbot.py Show resolved Hide resolved

herobank110 marked this pull request as ready for review June 8, 2025 20:14

nicoddemus requested changes Jun 10, 2025

View reviewed changes

nicoddemus requested a review from The-Compiler June 10, 2025 13:19

herobank110 and others added 12 commits June 12, 2025 20:14

update to mypy 1.16

4aa9d93

Co-authored-by: Bruno Oliveira <[email protected]>

Merge branch 'master' into type_annotation_test

66b5264

change Generator to Iterator

786aa1e

Co-authored-by: Bruno Oliveira <[email protected]>

move error types to classvars

2d0adb1

add mypy config file

7bdb099

exclude docs, remove type ignore comment

a55f75d

change cast to annotation

3b95d0e

change cast str to str conversion

9ac08ed

Co-authored-by: Bruno Oliveira <[email protected]>

ignore unused ignore

58c1545

type alias annotation for qt objects

3951f6f

remove quotes from type

4a0acb5

Update CHANGELOG.rst

fd4229e

nicoddemus previously approved these changes Jun 13, 2025

View reviewed changes

Update setup.py

794bdad

nicoddemus dismissed their stale review via 794bdad June 13, 2025 15:56

Update qtbot.py

bd3f70a

nicoddemus previously approved these changes Jun 13, 2025

View reviewed changes

Update qtbot.py

dd07768

nicoddemus dismissed their stale review via dd07768 June 13, 2025 16:00

nicoddemus approved these changes Jun 13, 2025

View reviewed changes

The-Compiler requested changes Jun 18, 2025

View reviewed changes

		CapturedException = Tuple[Type[BaseException], BaseException, TracebackType]
		CapturedExceptions = List[CapturedException]

	signals: List[SignalInstance],
	signals: list[SignalInstance],

	check_params_cbs: Optional[List[CheckParamsCb]] = None,
	check_params_cbs: Optional[list[CheckParamsCb]] = None,

	self, method_name: str, adjective_name: str, widget: QWidget, timeout: int
	self, method_name: str, adjective_name: Literal["activated", "exposed"], widget: QWidget, timeout: int

	exc_type: Optional[Type[BaseException]],
	exc_type: Optional[type[BaseException]],

Uh oh!

Type annotation infrastructure and initial typing for qtbot.py #605

Are you sure you want to change the base?

Type annotation infrastructure and initial typing for qtbot.py #605

Uh oh!

Conversation

herobank110 commented May 22, 2025 • edited by nicoddemus Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nicoddemus left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nicoddemus left a comment

Choose a reason for hiding this comment

Uh oh!

nicoddemus commented Jun 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

herobank110 commented Jun 15, 2025

Uh oh!

The-Compiler left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

herobank110 commented May 22, 2025 •

edited by nicoddemus

Loading

nicoddemus commented Jun 13, 2025 •

edited

Loading